Docs/env vars contract ids custom rpc wallet flow - #324
Merged
valoryyaa-byte merged 4 commits intoAug 31, 2026
Merged
Conversation
|
@Mimah97 Great news! 🎉 Based on an automated assessment of this PR, the linked Wave issue(s) no longer count against your application limits. You can now already apply to more issues while waiting for a review of this PR. Keep up the great work! 🚀 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Adds four pieces of previously-missing documentation:
NEXT_PUBLIC_*environment variable the app actually reads, with purpose, type, and defaultsdefaults vs. empty mainnet defaults)
handles (not installed, locked, wrong network, rejected)
Every documented claim was traced to actual source code, not written from general assumption.
Changes
#236 — docs: document every NEXT_PUBLIC_* environment variable
NEXT_PUBLIC_*inventory indocs/environment-variables.md: network config (defaultnetwork, RPC URLs, fallback URLs), contract IDs (testnet with hardcoded defaults, mainnet requiring
explicit setup), optional API URL, app metadata
lib/stellar.ts,lib/contracts.ts,lib/api.ts,next.config.mjs, and.github/workflows/web.ymlor public endpoints)
#237 — docs: document deployed contract IDs per network and override mechanism
docs/environment-variables.mdContract IDs section: per-network values, required/optionalstatus, hardcoded defaults for testnet, empty defaults for mainnet, and override mechanism for each
docs/environment-variables.md#contract-idscontracts)
#238 — docs: add README section on running against a local or custom RPC
docs/custom-rpc.md: local quickstart (Soroban Docker), custom RPC provider setup, andfailover URL configuration
wrapped by public default
found)
#239 — docs: document wallet connection flow and Freighter failure modes
docs/wallet-connection.md: connection flow diagram, detection → prompt → network syncsession persistence via localStorage
lib/freighter.ts,hooks/useWallet.tsx,components/wallet/ConnectButton.tsxTest Plan
docs/environment-variables.mdend-to-end; verify every variable name matches code anddefaults match hardcoded values in
lib/stellar.tsandlib/contracts.tsdocs/custom-rpc.md; verify failover threshold (3) matcheslib/stellar.ts:FAILOVER_THRESHOLDhttp://localhost:8000worksdocs/wallet-connection.md; verify error messages match actual Freighter API strings inlib/freighter.tsrejected)
Closes #236, Closes #237, Closes #238, Closes #239